com.inscoper.nbo.MaskingPlate¶

Represents the XML element MaskingPlate. More...

Inherits from com.inscoper.nbo.OpticalAperture_Type, com.inscoper.nbo.ManufacturerSpec_Type, com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	MaskingPlate()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setFunction(MaskingPlateFunction_Type value, boolean validate) Sets the value of the Function attribute.
void	setFunction(MaskingPlateFunction_Type value) Sets the value of the Function attribute.
MaskingPlateFunction_Type	getFunction() Returns the value of the Function attribute.
void	resetFunction() Resets the Function attribute to an unset state.
boolean	hasFunction() Checks whether the optional Function attribute is present.
void	setExcitation(boolean value, boolean validate) Sets the value of the Excitation attribute.
void	setExcitation(boolean value) Sets the value of the Excitation attribute.
boolean	getExcitation() Returns the value of the Excitation attribute.
void	resetExcitation() Resets the Excitation attribute to an unset state.
boolean	hasExcitation() Checks whether the Excitation attribute is present.
void	setApertureSize(float value, boolean validate) Sets the value of the ApertureSize attribute.
void	setApertureSize(float value) Sets the value of the ApertureSize attribute.
float	getApertureSize() Returns the value of the ApertureSize attribute.
void	resetApertureSize() Resets the ApertureSize attribute to an unset state.
boolean	hasApertureSize() Checks whether the ApertureSize attribute is present.
void	setApertureSizeUnit(UnitsLength_Type value, boolean validate) Sets the value of the ApertureSizeUnit attribute.
void	setApertureSizeUnit(UnitsLength_Type value) Sets the value of the ApertureSizeUnit attribute.
UnitsLength_Type	getApertureSizeUnit() Returns the value of the ApertureSizeUnit attribute.
void	resetApertureSizeUnit() Resets the ApertureSizeUnit attribute to an unset state.
boolean	hasApertureSizeUnit() Checks whether the optional ApertureSizeUnit attribute is present.
void	setApertureNr_(int value, boolean validate) Sets the value of the ApertureNr_ attribute.
void	setApertureNr_(int value) Sets the value of the ApertureNr_ attribute.
int	getApertureNr_() Returns the value of the ApertureNr_ attribute.
void	resetApertureNr_() Resets the ApertureNr_ attribute to an unset state.
boolean	hasApertureNr_() Checks whether the ApertureNr_ attribute is present.
void	setApertureShape(String value, boolean validate) Sets the value of the ApertureShape attribute.
void	setApertureShape(String value) Sets the value of the ApertureShape attribute.
String	getApertureShape() Returns the value of the ApertureShape attribute.
void	resetApertureShape() Resets the ApertureShape attribute to an unset state.
boolean	hasApertureShape() Checks whether the ApertureShape attribute is present.
void	setMaterial(String value, boolean validate) Sets the value of the Material attribute.
void	setMaterial(String value) Sets the value of the Material attribute.
String	getMaterial() Returns the value of the Material attribute.
void	resetMaterial() Resets the Material attribute to an unset state.
boolean	hasMaterial() Checks whether the Material attribute is present.
MaskingPlate	__internal_create(long cPtr, boolean own)
MaskingPlate	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.
StringSet	getApertureShapeAllowedValues() Returns the allowed values for this attribut.
StringSet	getMaterialAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	MaskingPlate(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(MaskingPlate obj)

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.OpticalAperture_Type

	Name
	OpticalAperture_Type()
void	setID(LensID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LensID_Type value) Sets the value of the ID attribute.
LensID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value, boolean validate) Sets the value of the Name attribute.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setOpticsHolderPosition(String value, boolean validate) Sets the value of the OpticsHolderPosition attribute.
void	setOpticsHolderPosition(String value) Sets the value of the OpticsHolderPosition attribute.
String	getOpticsHolderPosition() Returns the value of the OpticsHolderPosition attribute.
void	resetOpticsHolderPosition() Resets the OpticsHolderPosition attribute to an unset state.
boolean	hasOpticsHolderPosition() Checks whether the OpticsHolderPosition attribute is present.
void	setOuterDiameter(float value, boolean validate) Sets the value of the OuterDiameter attribute.
void	setOuterDiameter(float value) Sets the value of the OuterDiameter attribute.
float	getOuterDiameter() Returns the value of the OuterDiameter attribute.
void	resetOuterDiameter() Resets the OuterDiameter attribute to an unset state.
boolean	hasOuterDiameter() Checks whether the OuterDiameter attribute is present.
void	setOuterDiameterUnit(UnitsLength_Type value, boolean validate) Sets the value of the OuterDiameterUnit attribute.
void	setOuterDiameterUnit(UnitsLength_Type value) Sets the value of the OuterDiameterUnit attribute.
UnitsLength_Type	getOuterDiameterUnit() Returns the value of the OuterDiameterUnit attribute.
void	resetOuterDiameterUnit() Resets the OuterDiameterUnit attribute to an unset state.
boolean	hasOuterDiameterUnit() Checks whether the optional OuterDiameterUnit attribute is present.
void	setAnnotationRef(AnnotationRef value, boolean validate) Sets the value of the AnnotationRef element.
void	setAnnotationRef(AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.
StringSet	getOpticsHolderPositionAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.OpticalAperture_Type

	Name
	OpticalAperture_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value, boolean validate) Sets the value of the Manufacturer attribute.
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
boolean	hasManufacturer() Checks whether the Manufacturer attribute is present.
void	setModel(String value, boolean validate) Sets the value of the Model attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
boolean	hasModel() Checks whether the Model attribute is present.
void	setCatalogNumber(String value, boolean validate) Sets the value of the CatalogNumber attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
boolean	hasCatalogNumber() Checks whether the CatalogNumber attribute is present.
void	setLotNumber(String value, boolean validate) Sets the value of the LotNumber attribute.
void	setLotNumber(String value) Sets the value of the LotNumber attribute.
String	getLotNumber() Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
boolean	hasLotNumber() Checks whether the LotNumber attribute is present.
void	setMapAnnotation_List(MapAnnotationVector value, boolean validate) Sets the list of MapAnnotation elements.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value, boolean validate) Adds a new MapAnnotation element to this object.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(FileAnnotation_Type value, boolean validate) Sets the value of the SpecsFile element.
void	setSpecsFile(FileAnnotation_Type value) Sets the value of the SpecsFile element.
FileAnnotation_Type	getSpecsFile() Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
boolean	hasSpecsFile() Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value, boolean validate) Sets the list of AdditionalVendorInformation elements.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value, boolean validate) Adds a new AdditionalVendorInformation element to this object.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
StringSet	getManufacturerAllowedValues() Returns the allowed values for this attribut.
StringSet	getModelAllowedValues() Returns the allowed values for this attribut.
StringSet	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
StringSet	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.MaskingPlate;

Represents the XML element MaskingPlate.

This element describes an opaque Masking Plate positioned in the light path to block specific components of the light beam.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.OpticalAperture_Type.delete

function MaskingPlate¶

public MaskingPlate()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromJsonFile

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromJsonFile

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromJsonString

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromJsonString

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromXmlFile

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromXmlFile

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromXmlString

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromXmlString

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.OpticalAperture_Type.toXmlFile

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.OpticalAperture_Type.toXmlFile

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.OpticalAperture_Type.toXmlString

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.OpticalAperture_Type.toXmlString

function setFunction¶

public void setFunction(
    MaskingPlateFunction_Type value,
    boolean validate
)

Sets the value of the Function attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field describes the Function of this Spatial Mask.

function setFunction¶

public void setFunction(
    MaskingPlateFunction_Type value
)

Sets the value of the Function attribute.

Parameters:

value The value to set

This field describes the Function of this Spatial Mask.

function getFunction¶

public MaskingPlateFunction_Type getFunction()

Returns the value of the Function attribute.

Return: The value of the attribute

This field describes the Function of this Spatial Mask.

function resetFunction¶

public void resetFunction()

Resets the Function attribute to an unset state.

This field describes the Function of this Spatial Mask.

function hasFunction¶

public boolean hasFunction()

Checks whether the optional Function attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field describes the Function of this Spatial Mask.

function setExcitation¶

public void setExcitation(
    boolean value,
    boolean validate
)

Sets the value of the Excitation attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records whether this Spatial Mask is placed in the Excitation (True) or the Emission (False) light path.

function setExcitation¶

public void setExcitation(
    boolean value
)

Sets the value of the Excitation attribute.

Parameters:

value The value to set

This field records whether this Spatial Mask is placed in the Excitation (True) or the Emission (False) light path.

function getExcitation¶

public boolean getExcitation()

Returns the value of the Excitation attribute.

Return: The value of the attribute

This field records whether this Spatial Mask is placed in the Excitation (True) or the Emission (False) light path.

function resetExcitation¶

public void resetExcitation()

Resets the Excitation attribute to an unset state.

This field records whether this Spatial Mask is placed in the Excitation (True) or the Emission (False) light path.

function hasExcitation¶

public boolean hasExcitation()

Checks whether the Excitation attribute is present.

Return: true if the attribute has been set, false otherwise

This field records whether this Spatial Mask is placed in the Excitation (True) or the Emission (False) light path.

function setApertureSize¶

public void setApertureSize(
    float value,
    boolean validate
)

Sets the value of the ApertureSize attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field captures the maximum physical Width of individual Apertures present in this Spatial Mask.

function setApertureSize¶

public void setApertureSize(
    float value
)

Sets the value of the ApertureSize attribute.

Parameters:

value The value to set

This field captures the maximum physical Width of individual Apertures present in this Spatial Mask.

function getApertureSize¶

public float getApertureSize()

Returns the value of the ApertureSize attribute.

Return: The value of the attribute

This field captures the maximum physical Width of individual Apertures present in this Spatial Mask.

function resetApertureSize¶

public void resetApertureSize()

Resets the ApertureSize attribute to an unset state.

This field captures the maximum physical Width of individual Apertures present in this Spatial Mask.

function hasApertureSize¶

public boolean hasApertureSize()

Checks whether the ApertureSize attribute is present.

Return: true if the attribute has been set, false otherwise

This field captures the maximum physical Width of individual Apertures present in this Spatial Mask.

function setApertureSizeUnit¶

public void setApertureSizeUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the ApertureSizeUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setApertureSizeUnit¶

public void setApertureSizeUnit(
    UnitsLength_Type value
)

Sets the value of the ApertureSizeUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getApertureSizeUnit¶

public UnitsLength_Type getApertureSizeUnit()

Returns the value of the ApertureSizeUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetApertureSizeUnit¶

public void resetApertureSizeUnit()

Resets the ApertureSizeUnit attribute to an unset state.

No description available in the XSD standard.

function hasApertureSizeUnit¶

public boolean hasApertureSizeUnit()

Checks whether the optional ApertureSizeUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setApertureNr_¶

public void setApertureNr_(
    int value,
    boolean validate
)

Sets the value of the ApertureNr_ attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field captures the Number of individual apertures present in this Spatial Mask.

function setApertureNr_¶

public void setApertureNr_(
    int value
)

Sets the value of the ApertureNr_ attribute.

Parameters:

value The value to set

This field captures the Number of individual apertures present in this Spatial Mask.

function getApertureNr_¶

public int getApertureNr_()

Returns the value of the ApertureNr_ attribute.

Return: The value of the attribute

This field captures the Number of individual apertures present in this Spatial Mask.

function resetApertureNr_¶

public void resetApertureNr_()

Resets the ApertureNr_ attribute to an unset state.

This field captures the Number of individual apertures present in this Spatial Mask.

function hasApertureNr_¶

public boolean hasApertureNr_()

Checks whether the ApertureNr_ attribute is present.

Return: true if the attribute has been set, false otherwise

This field captures the Number of individual apertures present in this Spatial Mask.

function setApertureShape¶

public void setApertureShape(
    String value,
    boolean validate
)

Sets the value of the ApertureShape attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field captures the Shape of individual apertures present in this Spatial Mask.

function setApertureShape¶

public void setApertureShape(
    String value
)

Sets the value of the ApertureShape attribute.

Parameters:

value The value to set

This field captures the Shape of individual apertures present in this Spatial Mask.

function getApertureShape¶

public String getApertureShape()

Returns the value of the ApertureShape attribute.

Return: The value of the attribute

This field captures the Shape of individual apertures present in this Spatial Mask.

function resetApertureShape¶

public void resetApertureShape()

Resets the ApertureShape attribute to an unset state.

This field captures the Shape of individual apertures present in this Spatial Mask.

function hasApertureShape¶

public boolean hasApertureShape()

Checks whether the ApertureShape attribute is present.

Return: true if the attribute has been set, false otherwise

This field captures the Shape of individual apertures present in this Spatial Mask.

function setMaterial¶

public void setMaterial(
    String value,
    boolean validate
)

Sets the value of the Material attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field captures the Material with which this Spatial Mask is constructed.

function setMaterial¶

public void setMaterial(
    String value
)

Sets the value of the Material attribute.

Parameters:

value The value to set

This field captures the Material with which this Spatial Mask is constructed.

function getMaterial¶

public String getMaterial()

Returns the value of the Material attribute.

Return: The value of the attribute

This field captures the Material with which this Spatial Mask is constructed.

function resetMaterial¶

public void resetMaterial()

Resets the Material attribute to an unset state.

This field captures the Material with which this Spatial Mask is constructed.

function hasMaterial¶

public boolean hasMaterial()

Checks whether the Material attribute is present.

Return: true if the attribute has been set, false otherwise

This field captures the Material with which this Spatial Mask is constructed.

function __internal_create¶

public static MaskingPlate __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalAperture_Type.__internal_create

function fromBase¶

public static MaskingPlate fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromBase

function getApertureShapeAllowedValues¶

public static StringSet getApertureShapeAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

This field captures the Shape of individual apertures present in this Spatial Mask.

function getMaterialAllowedValues¶

public static StringSet getMaterialAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

This field captures the Material with which this Spatial Mask is constructed.

Protected Functions Documentation¶

function MaskingPlate¶

protected MaskingPlate(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalAperture_Type.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.OpticalAperture_Type.finalize

function getCPtr¶

protected static long getCPtr(
    MaskingPlate obj
)

Updated on 2026-06-22 at 17:06:30 +0200